home *** CD-ROM | disk | FTP | other *** search
/ Dr. Windows 3 / dr win3.zip / dr win3 / PROGRAMR / HLPDK80.ZIP / HELPC.DOC < prev    next >
Text File  |  1993-08-01  |  23KB  |  547 lines
  1.  
  2.  ╔══════════════════════════════════════════════════════════════════════════╗
  3.  ║                                                                          ║
  4.  ║                                 ISoft D&M                                ║
  5.  ║                                 POB. 5517                                ║
  6.  ║                           Coralville IA 52241                            ║
  7.  ║                                   U.S.A                                  ║
  8.  ║                                                                          ║
  9.  ╚══════════════════════════════════════════════════════════════════════════╝ 
  10.  
  11. *******************************************************************************
  12. * HELPC Help Engine Technical specification and compiler user guide           *
  13. * LAST UPDATE - Aug. 01, 1993. (c) 1992,93 - Loewy Ron.                       *
  14. *******************************************************************************
  15.  
  16. *******************************************************************************
  17. *                              General Overview                               *
  18. *******************************************************************************
  19.  
  20.   The Help Engine database is a combination of text that is read by the user,
  21.  and a Topic and Links database that allows the user to view the topics
  22.  he is interested in, using hyper-text methods.
  23.  
  24.  
  25.   Each help database is built of 5 components : 
  26.  
  27.  1. Help Data File    - this file contains the raw text data.
  28.  2. Topic Index       - a database table that contains the topic names, and
  29.                         the references to the topics in the Data File.
  30.  3. Links Index       - a database table that contains the list of links 
  31.                         defined for each topic, and positional data.
  32.  4. Keywords Index    - a database table that contains the list of keywords,
  33.                         and the topics that have these keywords.
  34.  5. Set Data File     - a database configuration file that contains the
  35.                         names of the 3 components defined above, and some 
  36.                         additional information.
  37.  
  38.   Version 1.x is the bare-bones version that includes only the basic
  39.  operations needed from a hyper-text database, this version is implemented
  40.  using the Paradox Engine V3.0 to manage the Topic and Link index tables.
  41.  
  42.   Version 2.x has a new field in the topic table - the title field, help
  43.  databases that were compiled with V1.x will not be executed by version
  44.  2.x, they will have to be re-compiled!.
  45.  
  46.   Version 3.x fields have different length - the databases have to be 
  47.  re-compiled.
  48.  
  49.   Version 5.0+ has a new entry in the help set file, database have to be
  50.  re-compiled, ot the value 128 should be added in the last line of the help
  51.  set file, and the version number should be changed to 5.0.
  52.  
  53.   Version 6.0+ has added the keyword support - a new database table is added,
  54.  and a new set format is defined. Help databases will have to be re-compiled
  55.  for Natice targets.
  56.  
  57.   In Version 7.0 the title field has been expanded once more - to 70 
  58.  characters. Help databases will have to be re-compiled.
  59.  
  60.   In Version 8.0 the tType field was added to the Topics database. Old databases
  61.  will have to be re-compiled.
  62.  
  63.   The format of the help database is released to the public domain, if
  64.  you implement a database viewer on this database structure, I would be
  65.  happy to receive a copy ..
  66.  
  67. *******************************************************************************
  68. *                               Compiler Usage                                *
  69. *******************************************************************************
  70.  
  71.   The HELPC help compiler is a dos command line program that receives a 
  72.  help definition file (.HDF) and produce a help database. 
  73.  
  74.   The helpC command line is :
  75.  
  76.  HELPC source.fil [/Htopic-table-name] [/Llink-table-name] [/Ddata-file-name] 
  77.                   [/Kkeywords-table-name] [/R-]  [/ST-] [/CS+] [/EP+] [/WD-]
  78.                   [/RM-]
  79.                   [/W+]  [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+] [/XD+]
  80.                   [/PX+] [/MT+] [/OS2] [/TXT] [/RTF]
  81.  
  82.   The output of the compiler is a set data file called source.SET, that
  83.  includes the names of the other help database components. 
  84.  
  85.   Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler 
  86.  will generate a .HPJ and .RTF files that can be used with the Microsoft 
  87.  HC (v3.00b) or HC31 help compiler, and output a .HLP windows help file!. 
  88.  
  89.   By default the help compiler produces a help cross reference report on the 
  90.  topics/links used in the database, if the /R- switch is set, no cross-ref
  91.  report will be generated, and no database integrity indicators will be
  92.  given.
  93.  
  94.  
  95.   IMPORTANT - Scan the output cross reference report for links defined, that
  96.  are not defined as topics!
  97.  
  98.   Notice - An additional switch is available that instructs the help compiler
  99.  to indicate it's parse and code generation progress. Use the /EP+ switch to
  100.  see that the helpC compiler is active. Please understand that the compile
  101.  process can take a long time, on complex help databases. This switch does
  102.  nothing more that ensure to you that the help compiler is alive. 
  103.  
  104.   The /ST switch defines if the topic name defined in the .TOPIC command
  105.  can include embeded spaces. By default this switch is set to /ST- (No
  106.  embedded spaces).
  107.  
  108.   The /CS switch turns Topics and Links case sensativity to ON. Use this
  109.  switch with care - Only if you must have a lower/mixed case index in THELP
  110.  or POPHELP use this switch. Notice that help databases that compile fine
  111.  with case sensativity set to off, might fail to do so in case sensativity
  112.  on. By deafult this switch is set to off (-).
  113.  
  114.   The /XD switch generates code to the MDVXHELP help compiler, available
  115.  free in the file DVXHLP10.ZIP on the internet. When this switch is given,
  116.  a set of cover and section files is generated, as well as a response
  117.  file that should be used to compile the help database.
  118.  
  119.   The /OS2 switch generates IPF source code. You must compile the generated code 
  120.  with IPFC, from within an OS/2 session (window or full screen).
  121.  
  122.   The /WD switch controls Warning Display. By default Warning Display is On, if
  123.  you do not want to see the Warnings issued by the compiler when a topic name 
  124.  or link are found to be incomatible with the target source, and helpC 
  125.  translate them to be syntax compatible with the target.
  126.  
  127.   Use the /TXT switch to create a text file document from your .HDF source.
  128.  With this feature you can create on-line help and printed documentation
  129.  from the same source!.
  130.  
  131.   Use the /RTF switch to create a word-processor ready RTF file, import this
  132.  file (and update the fields e.g.- F9 in WinWord) to create a professional
  133.  formatted documentation from the same source code!.
  134.  
  135.   The /RM- switch uses disk cross-reference report tables. Usage of this 
  136.  option will allow the creation of cross-reference report for huge databases.
  137.  This options will slow the creation of reports, use it only for databases
  138.  so big that the report can not be generated using memory tables.
  139.  
  140. *******************************************************************************
  141. *                                Command Line                                 *
  142. *******************************************************************************
  143.  
  144.   The compiler switches are defined on the command line. These switches can
  145.  be placed before and after the source file name. The compiler will look for
  146.  a file named HELPC.CFG in the current directory, and process it before any
  147.  command line switches are processed. 
  148.  
  149.   Switches on the command line will over-ride switches set before them, on the
  150.  command line or in one of the response options file.
  151.  
  152.   Response option files can be specified by prefixing their name with a @ sign.
  153.  
  154.  Examples :
  155.  
  156.  If our HELPC.CFG file, in the current directory is :
  157.  
  158. /W31
  159. /R-
  160.  
  161.  And we compile using HELPC HELPDEMO
  162.  
  163.  The helpdemo.hdf file will be compiled, with the target set to winhelp 3.1
  164.  and no cr